docs: introduce DEPR pilot into OEP #660
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@robrap we made some more changes but there is still more to do, we'll continue to work on it at the next DEPR meeting but we will all try to review/add to what is here in the meantime. |
|
[Feel free to add to this TODO list if you aren't ready to make the updates.]
|
dianakhuang
reviewed
Jan 23, 2025
dianakhuang
reviewed
Jan 23, 2025
feanil
reviewed
Jan 23, 2025
|
|
||
| This approach would be most appropriate for features that can be left | ||
| in place for an extended period before removal and where a transition | ||
| to an alternative would require a moderate to large amount of | ||
| effort. For more trivial deprecations, it may be appropriate to simply | ||
| deprecate and remove within the same release cycle. | ||
|
|
||
| TODO: UPDATE THIS AND ALL OTHER PLACES TO MENTION target month + named release. Check the DEPR issue template as well. And scan throught the rest of this DEPR. |
There was a problem hiding this comment.
Also include a link to the release schedule in the DEPR template.
feanil
reviewed
Jan 23, 2025
| @@ -209,28 +209,40 @@ considers the timing of the next `Open edX named release`_. | |||
| periods will vary by the type and scope of the technical change. | |||
|
|
|||
There was a problem hiding this comment.
TODO: Update/replace the image in this DEPR.
There was a problem hiding this comment.
- Github can't display the graphviz. Are we ok with that?
- There is an image
Removal-Workflow.png, that also needs to be updated or removed.
Add some more thoughts and we'll come back with more edits in the next meeting.
Co-authored-by: Diana Huang <[email protected]>
feanil
force-pushed
the
robrap/OEP-update-for-DEPR-pilot-inclusion
branch
from
045cd7b to
c19683d
Compare
robrap
commented
Feb 6, 2025
| @@ -209,28 +209,40 @@ considers the timing of the next `Open edX named release`_. | |||
| periods will vary by the type and scope of the technical change. | |||
|
|
|||
There was a problem hiding this comment.
- Github can't display the graphviz. Are we ok with that?
- There is an image
Removal-Workflow.png, that also needs to be updated or removed.
| @@ -274,7 +294,7 @@ Do the following to document your proposal: | |||
| #. **Removal**: A description with links to what is being removed. | |||
| #. **Replacement**: A description with links to what it is being replaced by. | |||
| #. If you plan to mark the code for deprecation, explain how in the | |||
| **Deprecation** section. See Deprecated_ for considerations. | |||
| **Deprecation** section. See Deprecated for considerations. | |||
There was a problem hiding this comment.
Rather than just dropping the link from "See Deprecated_ for considerations", I think this whole sentence needs to be updated or removed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is to introduce the results of a successful pilot of some DEPR change into the DEPR OEP:
This was mostly around updated recommendations around DEPR timelines. The pilot was not perfect, and this update does not mean we can't iterate and improve.
Additionally, the pilot did not come up with a great way to determine when-and-if to DEPR, so separate follow-up will be needed for that.